Query Builder

The Query Builder is a tool for executing custom queries with the Localytics Query API and building custom reports. For more information, see Query API in the Developer documentation.

Use Query Builder to:

  • Generate custom reports that query across multiple apps or query for multiple metrics in a single report; for example, query for all users and sessions across all apps.
  • Generate custom reports that split by more than one dimension; for example, query users by country and acquisition source.

Example: You may want to report on user (Metric) by day and acquisition source (Dimensions), from January 1 to January 31 (Date Range) for all apps (Apps).

Running a query

To compose a query in the Query Builder:

  1. Scroll down to the bottom of any dashboard page, and then select Query Builder from the footer.

    This will take you to the Query Builder page, where you can build query reports based on the apps, metrics, dimensions, and date range (in the upper-right corner).

    Query Builder

  2. Fill in the Query Builder fields to your specifications:

    • In the Apps field, select one or more apps from the drop-down list or select Select All.

    • In the Metrics field, select one or more metrics from the drop-down list.

    • In the Dimensions field, select one or more session dimensions from the drop-down list.

    If your selections are incompatible, you will see an error message.

    Note: If you need assistance composing queries, feel free to reach out to the Support team for help.

  3. When you are done, select Submit Query.

    The results display on the Query Builder page when they are ready. Depending on the complexity (or broadness) of your query, this may take a little time.